Introduction

The VDoc development kit provides a new API which allows you to connect remotely to the VDoc server. This new client API manipulates the same interfaces and modules as the server API.

The client API includes all you need to integrate the features of VDoc Platform on any rich client-type applications.

Overview

All exchanges are done through HTTP. The client API is based on the XML and JSon flows which have been rewritten with XStream technology.

The client API is fully generated from the annotated Java Beans, provided for XStream, and an XML definition. In this way, other languages could be supported in the next releases.

Overview

Available services

The following services are available:

  • Authentication
  • Directory consultation (limited to the recovering of a user)
  • Document spaces consultation:
    • List of document spaces (ILibrary);
    • List of folders (IFolder);
    • List of categories (ICategory);
    • List of files (IFile).
    • Download an attachment from a file URI (IAttachment).
  • Consulting the objects related to the process management:
    • List of applications (IProject);
    • List of process groups (ICatalog);
    • List of processes (IWorkflowContainer);
    • List of process versions (IWorkflow, IResourceDefinition);
    • List of views (IView);
    • List of documents (IWorkflowInstance, ILinkedResource).
  • Consulting the objects related to the data stockrooms:
    • List of views (IView);
    • List of tables (IResourceDefinition);
    • List of records (IStorageResource).

Currently, the API is delivered for Objective-C and Java languages (in read mode). The first use of this API is for mobile applications (iPhone or Android).

This topic provides information about how to use this client API.

Programming tasks

The following topic gives you some examples on how to use the Java client API:

Client API distribution

The distribution of the client API is available on the DVD at Install/VDocSDKMobility folder.

Three distributions are available :

  • VDocSuite-suite-VDocPlatformSDKClientAndroid.zip
  • VDocSuite-suite-VDocPlatformSDKClientIOS.zip
  • VDocSuite-suite-VDocPlatformSDKClientJava.zip